/*
 * Copyright contributors to Besu.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
package org.hyperledger.besu.evm.frame;

/** The enum Soft Failure reason. */
public enum SoftFailureReason {

  /** Soft failure due to insufficient balance. Mainly use to provide visibility to Tracers. */
  LEGACY_INSUFFICIENT_BALANCE("insufficient balance for transfer"),
  /** Soft failure due to max call depth. Mainly use to provide visibility to Tracers. */
  LEGACY_MAX_CALL_DEPTH("max call depth exceeded");

  /** The Description of soft failure. */
  final String description;

  /**
   * Enum constructor with description
   *
   * @param description to set
   */
  SoftFailureReason(final String description) {
    this.description = description;
  }

  /**
   * Returns Description
   *
   * @return description.
   */
  public String getDescription() {
    return description;
  }
}
